@frontender-magazine/service-api

TM Micro Service API Prototype class

This class provide fetch wrapper, token and Service URL setter mainly. Just to avoid code duplication.

Requirements

Possibly you will need babel-polyfill to use it.

Documentation

Table of Contents

• ErrorBadRequest
  • Parameters
• ErrorCache
  • Parameters
• ErrorNotFound
  • Parameters
• ErrorServerResponse
  • Parameters
• MicroServiceAPI
  • Parameters
  • url
    • Properties
  • token
    • Properties
  • messages
  • setToken
    • Parameters
  • setVersion
    • Parameters
  • checkVersion
    • Parameters
  • request
    • Parameters
• tmpVersion
  • Properties

ErrorBadRequest

Custom error message for Bad Request server response

Parameters

• message (string | null) error details (optional, default null)

ErrorCache

Custom error message for cache fail

Parameters

• message (string | null) error details (optional, default null)

ErrorNotFound

Custom error message for Not Found server response

Parameters

• message (string | null) error details (optional, default null)

ErrorServerResponse

Custom error message for abstract server response

Parameters

• statusCode number http status code
• statusText string http status code text
• message (string | null) error details (optional, default null)

MicroServiceAPI

TM Micro Service Proto API

Parameters

• url string service url
• token (string | null) user access tocken if available (optional, default null)

url

Service URL

Properties

• service string url

token

User access token

Properties

• token (string | null)? user access tocken if available

messages

Object with class service messages

Type: Object

setToken

Set access token

Parameters

• token string access token

setVersion

Set service version

Parameters

• version string service version

checkVersion

Validate service version

Parameters

• version string service version

• Throws Error if URL do not match format Error will be thrown

Returns string version - service version

request

Fetch remote resource

Parameters

• url string resource url
• userOptions Object user defined options

Returns Promise Promise with server Response

tmpVersion

Service version

Properties

• version string? service version